home *** CD-ROM | disk | FTP | other *** search
/ MacTech 1 to 12 / MacTech-vol-1-12.toast / Source / MacTech® Magazine / Volume 09 - 1993 / 09.07 Jul 93 / Bedrock Header Files / Support Includes / BRStr.h < prev    next >
Encoding:
C/C++ Source or Header  |  1993-04-19  |  14.0 KB  |  297 lines  |  [TEXT/MPS ]
  1. /*========================================================================================
  2. / 
  3. /      File:        BRStr.h
  4. /      Release Version:    $ 1.0d1 $
  5. / 
  6. /      Creation Date:    November 4, 1989
  7. / 
  8. /      COPYRIGHT 1989-93 SYMANTEC CORPORATION. ALL RIGHTS RESERVED. UNPUBLISHED -- RIGHTS
  9. /      RESERVED UNDER THE COPYRIGHT LAWS OF THE UNITED STATES. USE OF COPYRIGHT NOTICE IS
  10. /      PRECAUTIONARY ONLY AND DOES NOT IMPLY PUBLICATION OR DISCLOSURE.
  11. / 
  12. /      THIS SOFTWARE CONTAINS PROPRIETARY AND CONFIDENTIAL INFORMATION OF SYMANTEC
  13. /      CORPORATION. USE, DISCLOSURE, OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR
  14. /      EXPRESS WRITTEN PERMISSION OF SYMANTEC CORPORATION.
  15. / 
  16. /      RESTRICTED RIGHTS LEGEND
  17. /      Use, duplication, or disclosure by the Government is subject to restrictions as Set
  18. /      forth in subparagraph (c)(l)(ii) of the Rights in Technical Data and Computer
  19. /      Software clause at DFARS 252.227-7013. Symantec Corporation, 10201 Torre Avenue,
  20. /      Cupertino, CA 95014.
  21. / 
  22. /=======================================================================================*/
  23.  
  24. /*--------------------------------------------------------------------------------------
  25. //    This file is part of the old international implementation.
  26. //    The Bedrock team is in the process of designing a totally new approach.
  27. //    For more details on the new approach please look in the 
  28. //    "…:BEDROCK:INTL:INCLUDES:" folder.
  29. //    The new approach departs from the close tie to characters and characterSets.
  30. //    Instead it bases all internationalization efforts on locale based
  31. //    characters, and character sets, with Unicode as the central set.
  32. /--------------------------------------------------------------------------------------*/
  33.  
  34.  
  35. #ifndef BRSTR_H
  36. #define BRSTR_H
  37.  
  38. #ifndef BRSUPDEF_H
  39. #include "BRSupDef.h"
  40. #endif
  41.  
  42. #ifdef __cplusplus
  43.   extern "C" {
  44. #endif
  45.  
  46.  
  47.  
  48. #define BR_BEDSTRING_LENGTHCOUNT 2
  49. #define BR_BEDSTRING_OVERHEAD 4
  50.  
  51. #if (BR_BEDSTRING_LENGTHCOUNT == 2)
  52. #define BR_BEDSTRING_SETCOUNT(string,cnt) {*(unsigned short FAR *)(string)=(unsigned short)(cnt);}
  53. #define BR_BEDSTRING_GETCOUNT(string) ((unsigned short)*(unsigned short FAR *)(string))
  54. #else
  55. #define BR_BEDSTRING_SETCOUNT(string,cnt) {*(unsigned char FAR *)(string)=(unsigned char)(cnt);}
  56. #define BR_BEDSTRING_GETCOUNT(string) ((unsigned short)*(unsigned char FAR *)(string))
  57. #endif
  58.  
  59. #define BR_TEXTSET_SBCS 1
  60. #define BR_TEXTSET_DBCS 2
  61. #define BR_TEXTSET_MBCS 3
  62.  
  63. #define BR_TEXTSET BR_TEXTSET_SBCS
  64.  
  65. #if (BR_TEXTSET == BR_TEXTSET_SBCS)
  66. #define BR_StringByteLength(string,count) (count)
  67. #define BR_FullStringCharacterCount(string,len) (len)
  68. #else
  69. #if (BR_TEXTSET == BR_TEXTSET_DBCS)
  70. #define BR_StringByteLength(string,count) (count*2)
  71. #define BR_FullStringCharacterCount(string,len) (len/2)
  72. #else
  73. /* Must be MBCS, use procedures to count */
  74. #define BR_StringByteLength(string,count) ERROR_FUNCTION_MISSING
  75. #define BR_FullStringCharacterCount(string,len) ERROR_FUNCTION_MISSING
  76. #endif
  77. #endif
  78.  
  79. typedef unsigned short BR_ParseTokenType;
  80. typedef unsigned short BR_ParseTokenClass;
  81. typedef BR_StringPtr BR_ParseTokenPtr;
  82. typedef unsigned short BR_ParseTokenCount;
  83.  
  84. typedef struct BR_SParsingToken
  85.    {
  86.    BR_ParseTokenType fTokenType;
  87.    BR_ParseTokenClass fTokenClass;
  88.    BR_ParseTokenPtr fTokenPtr;
  89.    BR_ParseTokenCount fTokenCount;
  90.    } BR_SParsingToken, FAR * BR_SParsingTokenPtr;
  91.  
  92. typedef enum BR_ParseClass
  93. {
  94.     BR_ParseClass_kString,
  95.     BR_ParseClass_kRun
  96. } BR_ParseClass;
  97.  
  98. typedef struct BR_SParseList
  99.    {
  100.    BR_ParseTokenPtr fParseStr;
  101.    BR_ParseTokenCount fParseCnt;
  102.    BR_ParseTokenType fParseType;
  103.    BR_ParseClass fParseClass;
  104.    } BR_SParseList, FAR * BR_SParseListPtr;
  105. /* String Procedures */
  106.  
  107. typedef unsigned short BS_StringLength;
  108. /* Each of the string Copy procedures Copy str2 to str1, i.e. str1=str2; */
  109.  
  110. BR_EXPORTENTRY(char FAR *) BR_ByteMemoryMove (char FAR *  str1, char FAR *  str2, unsigned short len);
  111. BR_EXPORTENTRY(BR_StringPtr) BR_MemoryMove      (BR_StringPtr str1, BR_StringPtr str2, BS_StringLength cnt);
  112.  
  113. BR_EXPORTENTRY(BR_BedString) BR_CopyToBedString (BR_BedString str1, BR_StringPtr str2, BS_StringLength cnt);
  114. BR_EXPORTENTRY(BR_AnsiString) BR_CopyToAnsiString   (BR_AnsiString   str1, BR_StringPtr str2, BS_StringLength cnt);
  115. BR_EXPORTENTRY(BR_PascalString) BR_CopyToPascalString   (BR_PascalString   str1, BR_StringPtr str2, BS_StringLength cnt);
  116.  
  117. BR_EXPORTENTRY(BR_BedString) BR_CopyPascalStringToBedString (BR_BedString str1, BR_PascalString str2);
  118. BR_EXPORTENTRY(BR_PascalString) BR_PascalStringCopy          (BR_PascalString   str1, BR_PascalString str2);
  119. BR_EXPORTENTRY(BR_AnsiString) BR_PascalStringToAnsiStringCopy   (BR_AnsiString   str1, BR_PascalString str2);
  120.  
  121. BR_EXPORTENTRY(BR_BedString) BR_AnsiStringToBedStringCopy (BR_BedString str1, BR_AnsiString str2);
  122. BR_EXPORTENTRY(BR_AnsiString) BR_AnsiStringCopy          (BR_AnsiString   str1, BR_AnsiString str2);
  123. BR_EXPORTENTRY(BR_PascalString) BR_AnsiStringToPascalStringCopy   (BR_PascalString   str1, BR_AnsiString str2);
  124.  
  125. BR_EXPORTENTRY(BR_BedString) BR_ModulaStringToBedStringCopy (
  126.     unsigned short str1Max,
  127.     BR_BedString str1,
  128.     unsigned short str2Max,
  129.     BR_StringPtr str2);
  130.  
  131. BR_EXPORTENTRY(BR_BedString) BR_BedStringCopy         (BR_BedString str1, BR_BedString str2);
  132. BR_EXPORTENTRY(BR_PascalString) BR_BedStringToPascalStringCopy (BR_PascalString   str1, BR_BedString str2);
  133. BR_EXPORTENTRY(BR_AnsiString) BR_BedStringToAnsiStringCopy (BR_AnsiString   str1, BR_BedString str2);
  134.  
  135. BR_EXPORTENTRY(BR_PascalString) BR_PascalStringConcatenate (BR_PascalString   str1, BR_PascalString   str2);
  136. BR_EXPORTENTRY(BR_AnsiString) BR_AnsiStringConcatenate (BR_AnsiString   str1, BR_AnsiString   str2);
  137. BR_EXPORTENTRY(BR_BedString) BR_BedStringConcatenate  (BR_BedString str1, BR_BedString str2);
  138.  
  139. typedef short BR_StringCompareResult;
  140.  
  141. BR_EXPORTENTRY(BR_StringCompareResult) BR_StringCompare (BR_StringPtr  str1, BS_StringLength cnt1, BR_StringPtr str2, BS_StringLength cnt2);
  142. BR_EXPORTENTRY(BR_StringCompareResult) BR_PascalStringCompare  (BR_PascalString   str1, BR_PascalString   str2);
  143. BR_EXPORTENTRY(BR_StringCompareResult) BR_AnsiStringCompare  (BR_AnsiString   str1, BR_AnsiString   str2);
  144. BR_EXPORTENTRY(BR_StringCompareResult) BR_BedStringCompare   (BR_BedString str1, BR_BedString str2);
  145.  
  146. BR_EXPORTENTRY(BR_StringCompareResult) BR_StringCompareIgnoreCase (BR_StringPtr    str1, BS_StringLength cnt1, BR_StringPtr str2, BS_StringLength cnt2);
  147. BR_EXPORTENTRY(BR_StringCompareResult) BR_BedStringCompareIgnoreCase   (BR_BedString str1, BR_BedString str2);
  148. BR_EXPORTENTRY(BR_StringCompareResult) BR_PascalStringCompareNoCase  (BR_PascalString    str1, BR_PascalString   str2);
  149. BR_EXPORTENTRY(BR_StringCompareResult) BR_AnsiStringCompareIgnoreCase  (BR_AnsiString    str1, BR_AnsiString   str2);
  150.  
  151. BR_EXPORTENTRY(BR_PascalString) BR_AnsiStringToPascalString   (BR_AnsiString   str1); /*C str to Pascal str*/
  152. BR_EXPORTENTRY(BR_PascalString) BR_BedStringToPascalString      (BR_BedString str1); /*Bedrock str to Pascal str*/
  153. BR_EXPORTENTRY(BR_AnsiString) BR_BedStringToAnsiString      (BR_BedString str1); /*Bedrock str to C str*/
  154. BR_EXPORTENTRY(BR_AnsiString) BR_PascalStringToAnsiString   (BR_PascalString   str1); /*Pascal str to C str*/
  155. BR_EXPORTENTRY(BR_BedString) BR_AnsiStringToBedString (BR_AnsiString   str1); /*C str to Bedrock str*/
  156. BR_EXPORTENTRY(BR_BedString) BR_PascalStringToBedString (BR_PascalString   str1); /*Pascal str to Bedrock str*/
  157.  
  158. BR_EXPORTENTRY(unsigned short) BR_PascalStringByteLen  (BR_PascalString   str1);   /*Get physical length of str*/
  159. BR_EXPORTENTRY(unsigned short) BR_AnsiStringByteLen  (BR_AnsiString   str1);
  160. BR_EXPORTENTRY(unsigned short) BR_BedStringByteLen   (BR_BedString str);
  161. /*BR_EXPORTENTRY(unsigned short)  BR_StringByteLength (BR_StringPtr str1, BS_StringLength cnt);*/
  162.  
  163. BR_EXPORTENTRY(BS_StringLength) BR_PascalStringCount (BR_PascalString   str1);     /*Get character count of str*/
  164. BR_EXPORTENTRY(BS_StringLength) BR_AnsiStringCount (BR_AnsiString   str1);
  165. BR_EXPORTENTRY(BS_StringLength) BR_BedStringCount  (BR_BedString str);
  166.  
  167. BR_EXPORTENTRY(void) BR_SetPascalStringByteLength   (BR_PascalString   str, unsigned short len);
  168. BR_EXPORTENTRY(void) BR_SetAnsiStringByteLength   (BR_AnsiString   str, unsigned short len);
  169. BR_EXPORTENTRY(void) BR_SetBedStringByteLength (BR_BedString str, unsigned short len);
  170.  
  171. BR_EXPORTENTRY(void) BR_SetPascalStringCount     (BR_PascalString   str, BS_StringLength cnt);
  172. BR_EXPORTENTRY(void) BR_SetAnsiStringCount     (BR_AnsiString   str, BS_StringLength cnt);
  173. BR_EXPORTENTRY(void) BR_SetBedStringCount (BR_BedString str, BS_StringLength cnt);
  174.  
  175. /*
  176.    These functions insert str2 into str1 at the insertnumber given replacing
  177.    the insert marker with the str2 string. %%{number} is an insertion marker.
  178.  
  179.    Ex. str1 = "Greetings %%1, you are %%2 fYears old."
  180.        s2a = "Robert"
  181.        s2b = "28"
  182.        BR_BedStringSubstitute (str1, s2a, 1);
  183.       result after call: str1 = "Greetings Robert, you are %%2 fYears old."
  184.        BR_BedStringSubstitute (str1, s2b, 2);
  185.       result after call: str1 = "Greetings Robert, you are 28 fYears old."
  186.  
  187.    These functions should be used for ALL string insertions to allow for easy
  188.    internationalization of the strings.
  189. */
  190.  
  191. BR_EXPORTENTRY(BR_StringPtr) BR_StringSubstitute (BR_StringPtr str1, BS_StringLength cnt1,
  192.                  BR_StringPtr str2, BS_StringLength cnt2,
  193.                  short insertnumber, BS_StringLength FAR * newcnt );
  194. BR_EXPORTENTRY(BR_PascalString) BR_PascalStringSubstitute (BR_PascalString str1, BR_PascalString str2, short insertNumber);
  195. BR_EXPORTENTRY(BR_AnsiString) BR_AnsiStringSubstitute (BR_AnsiString str1, BR_AnsiString str2, short insertNumber);
  196. BR_EXPORTENTRY(BR_BedString) BR_BedStringSubstitute (BR_BedString str1, BR_BedString str2, short insertNumber);
  197.  
  198. /*
  199.    These functions will insert string 2 into string 1 after the character
  200.    specified by the given position pos.  To insert at the beginning of the
  201.    string use the Value 0 for the position.
  202.    Note C string users: the position is character position not array position,
  203.             i.e. the first character is position 1 not 0.
  204. */
  205.  
  206. BR_EXPORTENTRY(BR_StringPtr) BR_StringInsert (BR_StringPtr str1, BS_StringLength cnt1,
  207.                   BR_StringPtr str2, BS_StringLength cnt2, unsigned short pos );
  208. BR_EXPORTENTRY(BR_PascalString) BR_PascalStringInsert (BR_PascalString str1, BR_PascalString str2, unsigned short pos);
  209. BR_EXPORTENTRY(BR_AnsiString) BR_AnsiStringInsert (BR_AnsiString str1, BR_AnsiString str2, unsigned short pos);
  210. BR_EXPORTENTRY(BR_BedString) BR_BedStringInsert (BR_BedString str1, BR_BedString str2, unsigned short pos);
  211.  
  212. BR_EXPORTENTRY(BR_StringPtr) BR_ConcatenateStringCharacter (BR_StringPtr str, BS_StringLength cnt, BR_StringCharacter c);
  213. BR_EXPORTENTRY(void) BR_BedStrConcatStringCharacter (BR_BedString str, BR_StringCharacter c);
  214.  
  215. BR_EXPORTENTRY(BR_Boolean) BR_FindString (BR_StringPtr FAR * baseStr, BS_StringLength baseCnt,
  216.             BR_StringPtr locStr, BS_StringLength locCnt, BR_Boolean flCaseSensitive);
  217.  
  218. BR_EXPORTENTRY(BR_VMHandle) BR_TokenizeFromList (BR_StringPtr str, BS_StringLength len, unsigned short FAR * count,
  219.                     BR_SParseListPtr pList, unsigned short listCount);
  220. /* String Case operators */
  221.  
  222. BR_EXPORTENTRY(BR_PascalString) BR_PascalStringUpperCase (BR_PascalString str1);
  223. BR_EXPORTENTRY(BR_AnsiString) BR_AnsiStringUpperCase (BR_AnsiString str1);
  224. BR_EXPORTENTRY(BR_BedString) BR_BedStringUpperCase (BR_BedString str1);
  225. BR_EXPORTENTRY(BR_StringPtr) BR_StringUpperCase (BR_StringPtr str1, BS_StringLength cnt);
  226.  
  227. BR_EXPORTENTRY(BR_PascalString) BR_PascalStringLowerCase (BR_PascalString str1);
  228. BR_EXPORTENTRY(BR_AnsiString) BR_AnsiStringLowerCase (BR_AnsiString str1);
  229. BR_EXPORTENTRY(BR_BedString) BR_BedStringLowerCase (BR_BedString str1);
  230. BR_EXPORTENTRY(BR_StringPtr) BR_StringLowerCase (BR_StringPtr str1, BS_StringLength cnt);
  231.  
  232.  
  233. /* Number conversion procedures */
  234. BR_EXPORTENTRY(BS_StringLength) BR_NumberToString (
  235.     long num, 
  236.     unsigned short base,
  237.     BR_StringPtr  s,
  238.     unsigned short maxlen);
  239. BR_EXPORTENTRY(BR_Boolean) BR_StringToNumber (
  240.     BR_StringPtr  s,
  241.     BS_StringLength characterCnt, 
  242.     unsigned short base, 
  243.     long FAR * num);
  244. BR_EXPORTENTRY(BS_StringLength) BR_PositiveNumberToString (
  245.     unsigned long num,
  246.     unsigned short base,
  247.     BR_StringPtr s,
  248.     unsigned short maxlen);
  249. BR_EXPORTENTRY(BR_Boolean) BR_StringToPositiveNumber (
  250.     BR_StringPtr  s,
  251.     BS_StringLength characterCnt,
  252.     unsigned short base,
  253.     unsigned long FAR * num);
  254. BR_EXPORTENTRY(short) BR_StringToShort (BR_StringPtr  str1, BS_StringLength characterCnt);
  255. BR_EXPORTENTRY(long) BR_StringToLong (BR_StringPtr  str1, BS_StringLength characterCnt);
  256. BR_EXPORTENTRY(BS_StringLength) BR_ShortToString (BR_StringPtr str1, short maxlen, short num);
  257. BR_EXPORTENTRY(BS_StringLength) BR_LongToString (BR_StringPtr str1, short maxlen, long num);
  258. BR_EXPORTENTRY(BS_StringLength) BR_ShortToHexString (BR_StringPtr str1, short maxlen, short num);
  259. BR_EXPORTENTRY(BS_StringLength) BR_LongToHexString (BR_StringPtr str1, short maxlen, long num);
  260. BR_EXPORTENTRY(long) BR_RomanStringToLong (BR_StringPtr str1, BS_StringLength cnt);
  261. BR_EXPORTENTRY(short) BR_RomanStringToShort (BR_StringPtr str1, BS_StringLength cnt);
  262.  
  263. BR_EXPORTENTRY(BS_StringLength) BR_LongToRomanString (
  264.     BR_StringPtr str1,
  265.     unsigned short maxlen,
  266.     long num,
  267.     BR_Boolean isUpperCase);
  268. BR_EXPORTENTRY(BS_StringLength) BR_ShortToRomanString (
  269.     BR_StringPtr str1,
  270.     unsigned short maxlen,
  271.     short num,
  272.     BR_Boolean isUpperCase);
  273.  
  274.  
  275. BR_EXPORTENTRY(short) BR_BedStringToShort (BR_BedString str1);
  276. BR_EXPORTENTRY(long) BR_BedStringToLong (BR_BedString str1);
  277. BR_EXPORTENTRY(BR_BedString) BR_ShortToBedString (BR_BedString str1, short num);
  278. BR_EXPORTENTRY(BR_BedString) BR_LongToBedString (BR_BedString str1, long num);
  279. BR_EXPORTENTRY(short) BR_RomanBedStringToShort (BR_BedString str1);
  280. BR_EXPORTENTRY(long) BR_RomanBedStringToLong (BR_BedString str1);
  281. BR_EXPORTENTRY(BR_BedString) BR_ShortToRomanBedString (BR_BedString str1, short num, BR_Boolean isUpperCase);
  282. BR_EXPORTENTRY(BR_BedString) BR_LongToRomanBedString (BR_BedString str1, long num, BR_Boolean isUpperCase);
  283. BR_EXPORTENTRY(BR_BedString) BR_ShortToHexBedString (BR_BedString str1, short num);
  284. BR_EXPORTENTRY(BR_BedString) BR_LongToHexBedString (BR_BedString str1, long num);
  285.  
  286. #ifdef BR_BUILD_PM
  287. BR_EXPORTENTRY(short) BedGetStrResource (HBEDANCHOR hab, unsigned long myType, unsigned long id,
  288.                         unsigned short maxSize, BR_BedString text);
  289. #endif
  290.  
  291.  
  292. #ifdef __cplusplus
  293.    }
  294. #endif
  295.  
  296. #endif
  297.